docs: add developer onboarding guide and API endpoint reference - #618
Merged
Chucks1093 merged 1 commit intoJul 27, 2026
Merged
Conversation
- Add local setup guide with prerequisites, step-by-step instructions, and troubleshooting - Add API endpoint reference with all public endpoints, auth requirements, and sample responses - Cross-link both documents for easy navigation Closes accesslayerorg#598
Member
|
This is really helpful for new contributors. Having both a setup guide and an endpoint reference in one PR means people can go from zero to running the server without digging through the code. Linking the two documents together makes it easy to navigate as well. |
Member
|
I see what you have done here, the setup docs and API reference give new contributors a clear path to get running without guessing at the config. Good job. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📌 Summary
This PR adds comprehensive developer documentation for the Access Layer server, covering local setup and API endpoint reference.
🎯 Purpose / Motivation
New contributors face two friction points: no documented path to get the server running locally, and no reference for what endpoints exist and what they return. This PR addresses both issues.
🛠️ Changes Made
docs/local-setup.mdwith prerequisites, step-by-step instructions, and troubleshootingdocs/api-endpoints.mdwith all public endpoints, auth requirements, and sample responses🧪 How to Test
curl http://localhost:3000/api/v1/healthhttp://localhost:3000/api-docscurl http://localhost:3000/api/v1/creators🔗 Related Issues
Closes #598
✅ Checklist